'\" t
.\"     Title: bugle-screenshot
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: October 2007
.\"    Manual: Bugle user manual
.\"    Source: BUGLE 0.0.20150628
.\"  Language: English
.\"
.TH "BUGLE\-SCREENSHOT" "7" "October 2007" "BUGLE 0.0.20150628" "Bugle user manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bugle-screenshot \- takes screenshots and captures video
.SH "SYNOPSIS"
.sp
.nf
filterset screenshot
{
    filename "\fIscreenshot\&.ppm\fR"
    key_screenshot "\fIC\-A\-S\-S\fR"
}
.fi
.sp
.nf
filterset screenshot \fIC\-V\fR inactive
{
    video "yes"
    filename "\fIvideo\&.avi\fR"
    codec "\fImpeg4\fR"
    bitrate "\fI1000000\fR"
    allframes "\fIno\fR"
}
.fi
.SH "DESCRIPTION"
.PP
The
screenshot
filter\-set can be used in one of two modes, corresponding to the two examples above\&. In the first, a particular key\-press causes a screenshot to be taken, which is written to file in
\fBppm\fR(5)
format\&. In the second, a video stream is captured and encoded to one of a range of formats with
\fBffmpeg\fR(1)\&.
.SH "OPTIONS"
.PP
\fBvideo\fR
.RS 4
This option controls the mode: either screenshots on request or a video stream\&. This filter\-set supports activation and deactivation, so it is possible to record video only on demand\&.
.RE
.PP
\fBfilename\fR
.RS 4
The file to which the image/video is written\&. In the case of an image, if the filename contains a
%
it is used as a format string for
\fBsprintf\fR(3)
with the frame number passed as the parameter\&.
.RE
.PP
\fBkey_screenshot\fR
.RS 4
The key combination used to capture a screenshot\&.
.RE
.PP
\fBcodec\fR
.RS 4
The codec to use when capturing a video\&. Refer to the documentation for
\fBffmpeg\fR(1)
for a list of valid codecs\&. Some codecs require special setup and may not work, but common codecs such as
mpeg4
and
huffyuv
should work\&.
.RE
.PP
\fBbitrate\fR
.RS 4
The approximate number of bits per second to use for video encoding\&.
.RE
.PP
\fBallframes\fR
.RS 4
By default, a frame is captured 30 times per second\&. If this option is set, every frame is captured\&. Note that the video file will still play at 30fps, so the speed will vary unless the application has been written to use a fixed time\-step between frames for its internal animation (this is a useful way to produce smooth video if the capturing overhead is otherwise too high)\&.
.RE
.PP
\fBlag\fR
.RS 4
Sets the latency between frame capture and encoding\&. If
GL_EXT_pixel_buffer_object
is available, setting this option to a value greater than 1 can help mask readback latency, at the expense of video memory\&.
.RE
.SH "AUTHOR"
.PP
bugle
is written and maintained by
Bruce Merry\&.
.SH "SEE ALSO"
.PP
\fBbugle\fR(3),
\fBppm\fR(5),
\fBffmpeg\fR(1)
